<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>v_hscaler: V_hscaler_v1_0</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_hscaler
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a>  </div>
  <div class="headertitle">
<div class="title">V_hscaler_v1_0</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v__hscaler__l2.html">XV_hscaler_l2</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Hw Configuration</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpe07496529b2051c7e9395499f7cf4d41"></a>The following constants define the scaler HW MAX configuration </p>
</td></tr>
<tr class="memitem:ga593fbc0878a09fc4cbd9c266c093ae2f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler__v1__0.html#ga593fbc0878a09fc4cbd9c266c093ae2f">XV_HScalerStart</a> (<a class="el" href="struct_x_v__hscaler.html">XV_hscaler</a> *InstancePtr)</td></tr>
<tr class="separator:ga593fbc0878a09fc4cbd9c266c093ae2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaecd2bdc61f4bd8be2450ed3bf5272c70"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler__v1__0.html#gaecd2bdc61f4bd8be2450ed3bf5272c70">XV_HScalerStop</a> (<a class="el" href="struct_x_v__hscaler.html">XV_hscaler</a> *InstancePtr)</td></tr>
<tr class="separator:gaecd2bdc61f4bd8be2450ed3bf5272c70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga92022129bcae2c8dc37a780d1bc6e16d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler__v1__0.html#ga92022129bcae2c8dc37a780d1bc6e16d">XV_HScalerLoadExtCoeff</a> (<a class="el" href="struct_x_v__hscaler.html">XV_hscaler</a> *InstancePtr, <a class="el" href="struct_x_v__hscaler__l2.html">XV_hscaler_l2</a> *HscL2DataPtr, u16 num_phases, u16 num_taps, const short *Coeff)</td></tr>
<tr class="separator:ga92022129bcae2c8dc37a780d1bc6e16d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e8a5bb6706c9c1d5a42b9f82728a867"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler__v1__0.html#ga6e8a5bb6706c9c1d5a42b9f82728a867">XV_HScalerSetup</a> (<a class="el" href="struct_x_v__hscaler.html">XV_hscaler</a> *InstancePtr, <a class="el" href="struct_x_v__hscaler__l2.html">XV_hscaler_l2</a> *HscL2DataPtr, u32 HeightIn, u32 WidthIn, u32 WidthOut, u32 cformat)</td></tr>
<tr class="separator:ga6e8a5bb6706c9c1d5a42b9f82728a867"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9b60edd661b746c72e78b085b2de6e3c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler__v1__0.html#ga9b60edd661b746c72e78b085b2de6e3c">XV_HScalerDbgReportStatus</a> (<a class="el" href="struct_x_v__hscaler.html">XV_hscaler</a> *InstancePtr)</td></tr>
<tr class="separator:ga9b60edd661b746c72e78b085b2de6e3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga3421a38c1ff14ad8815095f14f799ffc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__v__hscaler__v1__0.html#ga3421a38c1ff14ad8815095f14f799ffc">XV_HSCALER_TAPS</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hscaler__l2_8h.html">xv_hscaler_l2.h</a>&gt;</code></p>

<p>This typedef enumerates the supported taps. </p>

</div>
</div>
<a class="anchor" id="ga93cbecf16c1c2b4af00d7779c02aacfb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__v__hscaler__v1__0.html#ga93cbecf16c1c2b4af00d7779c02aacfb">XV_HSCALER_TYPE</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hscaler__l2_8h.html">xv_hscaler_l2.h</a>&gt;</code></p>

<p>This typedef enumerates the Scaler Type. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga9b60edd661b746c72e78b085b2de6e3c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HScalerDbgReportStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__hscaler.html">XV_hscaler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hscaler__l2_8c.html">xv_hscaler_l2.c</a>&gt;</code></p>

<p>This function prints H Scaler status on the console. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the instance pointer to the core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_v__hscaler___config.html#af657a187fb7fcf1189788eed9de87dd3">XV_hscaler_Config::BaseAddress</a>, <a class="el" href="struct_x_v__hscaler.html#a593e6539aa573e9b57c5126b8db1cc5b">XV_hscaler::Config</a>, <a class="el" href="struct_x_v__hscaler___config.html#aa46e23594ec1f8647bed471bc8d5fa98">XV_hscaler_Config::NumTaps</a>, <a class="el" href="struct_x_v__hscaler___config.html#a4282b794e8c469aa0c50cb28b3e282cd">XV_hscaler_Config::PhaseShift</a>, and <a class="el" href="struct_x_v__hscaler___config.html#a9b8f1147b245bb2a6af561ce87b161aa">XV_hscaler_Config::ScalerType</a>.</p>

</div>
</div>
<a class="anchor" id="ga92022129bcae2c8dc37a780d1bc6e16d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HScalerLoadExtCoeff </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__hscaler.html">XV_hscaler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_v__hscaler__l2.html">XV_hscaler_l2</a> *&#160;</td>
          <td class="paramname"><em>HscL2DataPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>num_phases</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>num_taps</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const short *&#160;</td>
          <td class="paramname"><em>Coeff</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hscaler__l2_8c.html">xv_hscaler_l2.c</a>&gt;</code></p>

<p>This function loads user defined filter coefficients in the scaler coefficient storage. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">HscL2DataPtr</td><td>is a pointer to the core instance layer 2 data. </td></tr>
    <tr><td class="paramname">num_phases</td><td>is the number of phases in coefficient table </td></tr>
    <tr><td class="paramname">num_taps</td><td>is the number of taps in coefficient table </td></tr>
    <tr><td class="paramname">Coeff</td><td>is a pointer to user defined filter coefficients table</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_v__hscaler.html#a593e6539aa573e9b57c5126b8db1cc5b">XV_hscaler::Config</a>, and <a class="el" href="struct_x_v__hscaler___config.html#a4282b794e8c469aa0c50cb28b3e282cd">XV_hscaler_Config::PhaseShift</a>.</p>

</div>
</div>
<a class="anchor" id="ga6e8a5bb6706c9c1d5a42b9f82728a867"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HScalerSetup </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__hscaler.html">XV_hscaler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_v__hscaler__l2.html">XV_hscaler_l2</a> *&#160;</td>
          <td class="paramname"><em>HscL2DataPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>HeightIn</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>WidthIn</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>WidthOut</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>cformat</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hscaler__l2_8c.html">xv_hscaler_l2.c</a>&gt;</code></p>

<p>This function configures the scaler core registers with the specified configuration parameters of the axi stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">HscL2DataPtr</td><td>is a pointer to the core instance layer 2 data. </td></tr>
    <tr><td class="paramname">HeightIn</td><td>is the input stream height </td></tr>
    <tr><td class="paramname">WidthIn</td><td>is the input stream width </td></tr>
    <tr><td class="paramname">WidthOut</td><td>is the output stream width </td></tr>
    <tr><td class="paramname">cformat</td><td>is the input stream color format</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_v__hscaler.html#a593e6539aa573e9b57c5126b8db1cc5b">XV_hscaler::Config</a>, <a class="el" href="struct_x_v__hscaler___config.html#a074a3b3e53bcbdc9510a82418d5df552">XV_hscaler_Config::PixPerClk</a>, and <a class="el" href="struct_x_v__hscaler___config.html#a9b8f1147b245bb2a6af561ce87b161aa">XV_hscaler_Config::ScalerType</a>.</p>

</div>
</div>
<a class="anchor" id="ga593fbc0878a09fc4cbd9c266c093ae2f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HScalerStart </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__hscaler.html">XV_hscaler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hscaler__l2_8c.html">xv_hscaler_l2.c</a>&gt;</code></p>

<p>This function starts the horizontal scaler core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a class="anchor" id="gaecd2bdc61f4bd8be2450ed3bf5272c70"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HScalerStop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v__hscaler.html">XV_hscaler</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__hscaler__l2_8c.html">xv_hscaler_l2.c</a>&gt;</code></p>

<p>This function stops the horizontal scaler core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
</div><!-- contents -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
